feat: de-proxy locale access by ST-DDT · Pull Request #3189 · faker-js/faker

ST-DDT · 2024-10-16T23:58:47Z

Second part of the standalone module function feature #2667

Proposal: Design for standalone module functions #2667

Fixes #3155

Support older browsers without Proxy #3155

Requires #2838

feat: introduce FakerCore #2838

Overview

Introduce FakerCore feat: introduce FakerCore #2838
De-proxy locale access feat: de-proxy locale access #3189
De-class config function feat: standalone module functions #3748 (seed, setDefaultRefDate, ...)
De-module functions feat: standalone module functions #3748 (airline, ...)

Description

Instead of calling this.faker.definitions.category.entry, we will now use resolveLocaleData(this.faker.fakerCore, 'category', 'entry').
Please note that this will get simplified with the next PR as this.faker.fakerCore will get replaced with just fakerCore.
This change makes the functions independent from the main faker instance, at least locale access wise.
That makes resolveLocaleData the first effective "standalone module function", as it no longer needs faker, only the fakerCore is needed.

As an additional benefit it also fixes #3155

Support older browsers without Proxy #3155 (as long as the full faker instance isn't created/the faker.definitions isn't accessed (when using lazy loading))

Recreating the PR

(Partially outdated)

Cherry-pick the first two commits.
Replace this\.faker\.definitions\.(\w+)\.(\w+) with assertLocaleData(this.faker.fakerCore.locale.$1?.$2, '$1.$2') in src.

Next Steps (Future PR)

The next step after this PR is converting the other methods to standalone module functions.

Current

export class AirlineModule extends ModuleBase {
  airport(): Airport {
    return this.faker.helpers.arrayElement(
      assertLocaleData(this.faker.fakerCore.locale.airline.airport, 'airline', 'airport')
    );
  }
}

Future

function airport(fakerCore: FakerCore): Airport {
  return arrayElement(fakerCore, 
    assertLocaleData(fakerCore.locale.airline.airport, 'airline', 'airport')
  );
}

export class AirlineModule extends ModuleBase {
  airport(): Airport {
    // return airport(this.faker.fakerCore);
    return airport(this.fakerCore);
  }
}

codecov · 2024-10-17T00:02:19Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.90%. Comparing base (c53c1fe) to head (c66ecb9).
⚠️ Report is 1 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #3189      +/-   ##
==========================================
- Coverage   98.90%   98.90%   -0.01%     
==========================================
  Files         897      898       +1     
  Lines        3103     3100       -3     
  Branches      556      572      +16     
==========================================
- Hits         3069     3066       -3     
  Misses         30       30              
  Partials        4        4

Files with missing lines	Coverage Δ
src/internal/assert-locale-data.ts	`100.00% <100.00%> (ø)`
src/internal/locale-proxy.ts	`100.00% <100.00%> (ø)`
src/modules/airline/index.ts	`100.00% <ø> (ø)`
src/modules/animal/index.ts	`100.00% <100.00%> (ø)`
src/modules/book/index.ts	`100.00% <100.00%> (ø)`
src/modules/color/index.ts	`100.00% <100.00%> (ø)`
src/modules/commerce/index.ts	`98.59% <100.00%> (ø)`
src/modules/company/index.ts	`100.00% <100.00%> (ø)`
src/modules/database/index.ts	`100.00% <ø> (ø)`
src/modules/date/index.ts	`100.00% <100.00%> (ø)`
... and 13 more

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ST-DDT · 2026-04-09T22:14:47Z

Should I push this PR forward (as a pre-step of #3748) or should I drop it in favor of #3748 (or its parts)?
(Affects all modules that have locale files, could likely be split into one PR per module as well)

TLDR: This PR intends to do:

Replace this.faker\.definitions\.(\w+)\.(\w+) and similar
with assertLocaleData(this.faker.fakerCore.locale.$1.$2, '$1.$2')

#3748 does the same just with this.faker.fakerCore -> fakerCore (during the move to separate files).

Shinigami92 · 2026-04-10T08:23:17Z

Should I push this PR forward (as a pre-step of #3748) or should I drop it in favor of #3748 (or its parts)? [...]

feat: standalone module functions #3748 touches 359 files right now, that are at least 259 files to much for me to make a proper review
so everything that helps to chunk the PRs down to <100 touched files per PR is a win for reviewers

matthewmayer · 2026-04-10T08:30:43Z

Agreed, if there are ways to chunk the more mechanical changes into seperate PRs like this that make the final PR smaller, and it doesn't break the build, then go for it.

netlify · 2026-04-12T14:31:44Z

✅ Deploy Preview for fakerjs ready!

Name	Link
🔨 Latest commit	`c66ecb9`
🔍 Latest deploy log	https://app.netlify.com/projects/fakerjs/deploys/69e4f40deef7960008a1bd61
😎 Deploy Preview	https://deploy-preview-3189.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

ST-DDT · 2026-04-12T15:15:25Z

I consider splitting this PR into 3 smaller PRs.

feat: introduce resolveLocaleData
refactor: replace Proxy locale access with resolveLocaleData
?: deprecate LocaleProxy

This PR is theoretically ready for review, but I would like to fix/simplify some code outside of this PR to reduce the diff (complexity).

ST-DDT · 2026-04-12T15:25:01Z

Decision Needed

Which of the three should we do?

const data = resolveLocaleData(core, 'database', 'collation');
Autocomplete works, but unable to jump directly to the definitions.
const data = assertLocaleData(core.locale.database?.coallation, 'database.coallation');
Basically a fancy require check. More verbose but also more flexible. Currently internal.
Add both variants, but internally use only one of them.

xDivisionByZerox · 2026-04-18T12:54:21Z

Decision Needed

Which of the three should we do?

const data = resolveLocaleData(core, 'database', 'collation');
Autocomplete works, but unable to jump directly to the definitions.

const data = assertLocaleData(core.locale.database?.coallation, 'database.coallation');
Basically a fancy require check. More verbose but also more flexible. Currently internal.

Add both variants, but internally use only one of them.

Team Decision

We go with option 2 for now. The internal API usage can be verbose, we can use tooling to make our lives easier if required.
The public API for users will be designed in a separate manner.

ST-DDT · 2026-04-19T16:06:17Z

Ready for review.

xDivisionByZerox

Looks good 👍

ST-DDT · 2026-04-19T16:11:08Z

I just thought about the following:
If we don't support browsers without Proxy anyway, then we could just use the LocaleProxy in the FakerCore.

Then we wouldn't need this PR at all.
We would continue to have the short redundancy free calls fakerCore.locale.airline.airport that will still throw.

Shinigami92 · 2026-04-19T16:27:46Z

Proxy seems fine, go wild

ST-DDT · 2026-04-19T17:31:57Z

I created an alternative to this PR:

refactor(core): expose core.locale as LocaleProxy #3820 (comment)

Withdrawn in favor of #3820

ST-DDT · 2026-04-20T19:37:37Z

We will continue to use our LocaleProxy instead of this PR.

Uh oh!

Conversation

ST-DDT commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Description

Recreating the PR

Next Steps (Future PR)

Current

Future

Uh oh!

codecov Bot commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ST-DDT commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Shinigami92 commented Apr 10, 2026

Uh oh!

matthewmayer commented Apr 10, 2026

Uh oh!

netlify Bot commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for fakerjs ready!

Uh oh!

ST-DDT commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ST-DDT commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

xDivisionByZerox commented Apr 18, 2026

Uh oh!

Uh oh!

ST-DDT commented Apr 19, 2026

Uh oh!

xDivisionByZerox left a comment

Choose a reason for hiding this comment

Uh oh!

ST-DDT commented Apr 19, 2026

Uh oh!

Shinigami92 commented Apr 19, 2026

Uh oh!

ST-DDT commented Apr 19, 2026

Uh oh!

ST-DDT commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ST-DDT commented Oct 16, 2024 •

edited

Loading

codecov Bot commented Oct 17, 2024 •

edited

Loading

ST-DDT commented Apr 9, 2026 •

edited

Loading

netlify Bot commented Apr 12, 2026 •

edited

Loading

ST-DDT commented Apr 12, 2026 •

edited

Loading

ST-DDT commented Apr 12, 2026 •

edited

Loading